home *** CD-ROM | disk | FTP | other *** search
/ Aminet 8 / Aminet 8 (1995)(GTI - Schatztruhe)[!][Oct 1995].iso / Aminet / util / misc / winarng068b.lha / winarrange0.68beta / WinArrange_E.doc (.txt) < prev    next >
GNU Info File  |  1995-06-25  |  15KB  |  325 lines
  1. This is Info file WinArrange_E.doc, produced by Makeinfo-1.55 from the
  2. input file WinArrange_E.texi.
  3.    Copyright 1995 Thomas Alexnat
  4.    Full  documentation  and  hints  for WinArrange under AmigaOS.
  5. WinArrange sorts  in  many  ways Windows on a screen. (documentation
  6. for release 2.0 (Version 0.68 (25.06.95)) of WinArrange)
  7. File: WinArrange_E.doc,  Node: Top,  Next: Purpose,  Prev: (DIR),  Up: (DIR)
  8. * Menu:
  9. W I N A R R A N G E   ( e n g l i s h )  D O C U M E N T A T I O N
  10. ==================================================================
  11. Release of WinArrange:
  12.      2.0
  13. WinArrange:
  14.      0.68 (25.06.95)
  15. english documentation:
  16.      0.2 (25.06.95)
  17. Operating system:
  18.      at least AmigaOS 2.04 (AmigaOS 3.1 is highly recommended!)
  19. Copyright (C) 1995 Thomas Alexnat
  20. To  contact the author of all files which are involved with WinArrange (i.e.
  21. executable of WinArrange itself, the different documentations and some other
  22. relevant files), try to reach one of the following addresses:
  23.          Thomas Alexnat
  24.          Westendstrasse 7
  25.          82110 Germering (Germany)
  26.      
  27.          Fido:     2:2480/700.5
  28.          MAX:      91:5150/10.5
  29.          E-Mail:   alexnat@eikon.e-technik.tu-muenchen.de
  30. Please read on for more information about using WinArrange.
  31. * Purpose::         Purpose of WinArrange
  32. * Installation::    Installing WinArrange
  33. * Usage::           How to handle with WinArrange
  34. * Tutorial::
  35. * Shell-Options::
  36. * Configuring::     Configure WinArrange
  37. * Hints::           Tips and Tricks
  38. * History::         Program History
  39. * Concept Index::   Word-Index
  40. File: WinArrange_E.doc,  Node: Purpose,  Next: Installation,  Prev: Top,  Up: Top
  41. Purpose
  42. *******
  43.    WinArrange is a small utility to rearrange your windows on the
  44. active screen.
  45. Why WinArrange ?
  46. ================
  47.    * In  former  days I went crazy, while sorting and arranging windows
  48.      on the  workbench  screen.  Several  shell, editor and normal
  49.      workbench windows were  untidying  my  beautiful  workenvironment.
  50.      I wasn't really cabable of knowing  what was really going on. The
  51.      only solution for this problem was to rearrange all windows on
  52.      this screen. Unfortunally, this event took me a lot of time. After
  53.      rebooting and starting my programms my workbench was again in a
  54.      mess.  As you know time is money, I started to write this little
  55.      programm to   make  the  life  under  AmigaOS  with  Intuition
  56.      windows  and  screens peacefuller.
  57.    * Another  important  point  is,  that I wanted to implement a
  58.      feature, which  nearly  every  operating  system should support:
  59.      The rearrangement of windows for accessing faster the applications.
  60. What does it do ?
  61. =================
  62.    WinArranges  has  got  the  abillity to reorganzie the windows on
  63. the active screen. This can be done in many different ways. You can
  64. cascade, shuffle or sort  the windows e.g. depending relatively on the
  65. current screen resolution or  aspect  ratio.  If  you don't want to
  66. have the windows sorted, which are owned  by the Workbench's task, you
  67. can just switch this off. Here is a list of some features:
  68.    * * many different sorting methods: e.g. horizontal, shuffle, chess,
  69.      user-defined
  70.    * * abillity to ignore windows for sorting (e.g. workbench window)
  71.    * * executable since AmigaOS 2.04 (37.175)
  72.    * * nearly all features AmigaOS provides are supported
  73.    * * continuing support and development
  74. File: WinArrange_E.doc,  Node: Installation,  Next: Usage,  Prev: Purpose,  Up: Top
  75. Installation
  76. ************
  77.    At  first  you  must check out, which version of AmigaOS you have
  78. installed.  Ususally  it should be something like 2.1 oder higher.
  79. Otherwise update your Hardware,  to  enjoy this litte utility.
  80. Installing WinArrange is very easy.  There  are  two  possibillities
  81. of  making  WinArrange start-ready for your system:
  82.   1. Double-click  on  the  `Install_English'  icon  (or  the desired
  83.      language).   For   novice  Users,  the  installation-script
  84.      auto-configures WinArrange.  For  detailed  information  read  the
  85.      concerning chapters. The installation-procedure will also copy
  86.      files like the onlinedocumentation and texinfofiles to the desired
  87.      directories.
  88.   2. Expert-Users can also drop the `WinArrange' icon into the desired
  89.      drawer  of  your  workstation,  due  to the fact, that WinArrange
  90.      is not too complicated.
  91. File: WinArrange_E.doc,  Node: Usage,  Next: Tutorial,  Prev: Installation,  Up: Top
  92. Usage
  93. *****
  94.    This  chapter  will  introduce  you,  dealing with WinArrange. See
  95. these few pages  as  a  tutorial. You will learn how to start and
  96. configure WinArrange for  your  special  own  needs  and  wishes.
  97. Please make sure, that you have followed the installing instruction in
  98. the corresponding chapter and install script.
  99. File: WinArrange_E.doc,  Node: Tutorial
  100. Tutorial
  101. ========
  102.    If  you  want  a  fast image, what WinArrange can do for you, you
  103. may double click  on  the  WinArrange  icon. The default setting is,
  104. that all resizable Windows  on the active screen are sorted vertically.
  105. Choosetype
  106. ----------
  107.    If  you  don't want, that the WorkBench's windows (which are
  108. containing all the  icons)  are  sorted,  you  can  switch  this off by
  109. adding/changing the tooltype `CHOOSETYPE'. Changing this tooltype is
  110. very easy:
  111.   1. Open the drawer on the WorkBench, where WinArrange is located.
  112.   2. Select the WinArrange Icon (just click once, not twice)
  113.   3. Hold down the menu button on your mouse (usually the right mouse
  114.      button), and select in the menu `ICON' the item `INFORMATION...'.
  115.   4. Now you can see, if already entered, different tooltypes.
  116.   5. Click on the line with the entry `(CHOOSETYPE=NOWB)'.
  117.   6. Then remove the two brackets, or if the line doesn't exist, add the
  118.            tooltype `CHOOSETYPE=NOWB' also without the brackets
  119.      and save these settings.
  120.    Now try to doubleclick on the icon. You will recognize, that
  121. WinArrange won't sort the WorkBench's windows.
  122. Sorttype
  123. --------
  124.    The  default sorting method of WinArrange is very boring. You can
  125. try to use another  system:  `CHESS'  --  You  have  only  to  change
  126. to tooltype `SORTTYPE'   from   `(SORTTYPE=HORIZ)'  to
  127. `SORTTYPE=CHESS'.  Please proceed in the same way a showed above.
  128.    Now you have seen, what WinArrange can do for you. We'll start now,
  129. with the detailed documentation
  130. File: WinArrange_E.doc,  Node: Shell-Options
  131. Shell-Options
  132. =============
  133.    As you have noticed, WinArrange is able to be started via a command
  134. shell or the  AmigaOS WorkBench. At first I explain you the
  135. CLI-template-string. Open a  command  shell  and go to the directory
  136. where WinArrange is located (e.g.  double-click  the  `Shell'  Icon  in
  137. `SYS:System/'  and  type  in `CD Utilities'):
  138.    To get the template-string(1) type the following sequence:
  139.      `WinArrange ?' [RETURN]
  140.    This should give you the follwing result:
  141.      `H=Horiz/K/N,V=Vert/K/N,C=Chess/S,S=Shuffle/S,WB=WBOnly/S,NoWB/S,Min/S,Max/S:'
  142. H=Horiz/K/N
  143.      The `Horiz' parameter requires an integer number. In other words,
  144.      it is are percentage number, which means, that in what way the
  145.      windows are expanded or shrinked horiontally.
  146. V=Vert/K/N
  147.      Same parameters and effects like `Horiz', but the resizing affects
  148.      the vertical size.
  149. C=Chess/S
  150.      This  is  a mutal exclude switch. All windows are sorted like a
  151.      chess table.  This  method  is  very interesting for big
  152.      resulutions and many windows. You can  keep  track  of all your
  153.      windows while seeing a part of the contents in the  windows.  The
  154.      `Horiz'  and  the  `Vert' have got the highest priority,  so  if
  155.      such  a parameter is set, the `Chess' sorting method will be
  156.      overiden by a normal `Shuffle' system.
  157. S=Shuffle/S
  158.      This is a mutal exclude switch. The windows are here placed in a
  159.      diagonal line, beginning at the left side of the current screen.
  160.      The top side and the window step depends on the active screenfont.
  161. WB=WBOnly/S
  162.      Using this switch will affect all windows which are owned by the
  163.      workbench task. WinArrange checks if the workbench flag is set.
  164.      Other windows are ignored. The opposite flag is `NoWB'
  165. NoWB/S
  166.      All windows which are not owned by the wokbench are involved in
  167.      rearranging.  The opposite command is `WBOnly'.
  168. Min/S
  169.      The  `Min' switch is some kind of a macro. It sets the `Horiz' and
  170.      `Vert'  options  to  1 percent. The `Min' command can be seen as a
  171.      global iconify option. The opposite function is `Max'
  172. Max/S
  173.      This  option sets `Horiz' and `Vert' to the maximum. The result is
  174.      the opposite side of `Min', as described above.
  175.    ---------- Footnotes ----------
  176.    (1)  The template-string should help the user a  little  bit.  It
  177. displays all arguments and options, which are needed to start
  178. succsessfully a program. Usually this string can be accessed by adding
  179. a question mark ``?'' to the command.
  180. File: WinArrange_E.doc,  Node: Configuring
  181. Configuring
  182. ===========
  183.    As you have seen, WinArrange is a powerfull tool. To keep track of
  184. all windows and sorting methods, WinArrnge has got the abillity to be
  185. configured via a config-file. This  file  is  stored  in  the
  186. logically  drive  `ENV:'  and is named `WinArrange.config'.
  187. Structure of the config-file
  188. ----------------------------
  189.    The  config-file  uses  normal  ASCII  strings and tags and is also
  190. readable humans.   Here  follow  some  declarations  which  are  needed
  191. to  use  the config-file.
  192. Semicolons
  193.      Semicolons  '`;''  are  treated  like  in  the  AmigaOS  shell or
  194.      Basic commands as remarks. A remark should start always at the
  195.      beginning of a new line. Multiple remarks in a line are not
  196.      allowed.
  197. other conditions
  198.      Please note, that WinArrange hasn't got a professional config-file
  199.      parser. If something weired happens, feel free to contact me.
  200.    To demomstrate, how the config-file works, I've included an example
  201. configuration-file.
  202.      ; $VER: WinArrange.config 0.2 (25.06.95)
  203.      ; 
  204.  1994 by Thomas Alexnat
  205.      ;
  206.      ; This is a configfile for WinArrange
  207.      ;
  208.      ; 1.
  209.      ;   Please note, that the keyword 'configtype', is a identifier
  210.      ;   for WinArranges' configparser. It may happen, that the format
  211.      ;   of the config changes in future. At the moment, the is only existing
  212.      ;   one type: 1
  213.      ;
  214.      ; 2.
  215.      ;   Semicolons ';' are treated like in AmigaOS or Basic as remarks
  216.      ;
  217.      ; 3.
  218.      ;   It is also allowed to enter are blank line
  219.      ;
  220.      ; 4.
  221.      ;   At this point of time, you may not use linebreaks. This means, that a
  222.      ;   name has got to be at maximum, only a full line, preceeded by a normal
  223.      ;   AmigaOS linebreak command.
  224.      ;
  225.      ; 5.
  226.      ;   The config file should be plain AmigaOS-ASCII
  227.      ;
  228.      ; Thank you, for reading all this information. You may also cut out these
  229.      ; remarks for speed improvisation
  230.      
  231.      ;Global options:
  232.      WBONLY            FALSE
  233.      
  234.      
  235.      ;Now all options and patterns for the windows:
  236.      ACCEPTWINDOW        Toolmanager?*
  237.      REJECTWINDOW        WorkBench
  238.      
  239.      ;Now all options and patterns for the tasks:
  240.      ACCEPTTASK        WorkBench
  241.      REJECTTASK        CEd
  242. Using Wildcards
  243. ---------------
  244.    It is also possible to use Wildcards for a more powerful
  245. performance. The entry `ACCEPTWINDOW Toolmanager?*' would accept all
  246. windows whose name is preceeded by `Toolmanager' and succeeded by any
  247. String. (e.g.: 'ToolmanagerDock')
  248.    Here is a small table how to use the wildcards:
  249.      Pattern        Matches
  250.      
  251.      ?              any single character
  252.      c*             zero or more occurrences of character c
  253.      c+             one or more occurrences of character c
  254.      \?             a question mark (?)
  255.      \*             an asterisk (*)
  256.      \+             a plus sign (+)
  257.    Any other character must match exactly.  The following table lists
  258. some examples.
  259.      Pattern       Matches
  260.      
  261.      abc           only abc
  262.      ab*c          ac, abc, or abbc
  263.      ab+c          abc, abbc, or abbbc
  264.      ab?*c         a string starting with ab and ending in c, for example, abxyzc
  265.      ab\*c         only ab*c
  266.    (1)
  267.    ---------- Footnotes ----------
  268.    (1)  Those examples were taken from the Amiga 'C'-Compiler SAS/C
  269. File: WinArrange_E.doc,  Node: Hints,  Next: History,  Prev: Configuring,  Up: Top
  270. Hints
  271. *****
  272.    * Due to the fact, that WinArrange is not a AmigaOS Commodity, it
  273.      hasn't got the abillity to be started or activated via hotkeys. I
  274.      recommend you to assign some keys with e.g. ToolManager, DockTool.
  275.    * WinArrange prints always his version string out. If you don't like
  276.      that, just copy the output to a file (e.g. `NIL:'). To keep in
  277.      control with your system, you may also enter something like this:
  278.      `WinArrange >LOGDIR:WinArrange.log'. If WinArrange has got some
  279.      problems, you'll see what WinArrange dumped in his logfile.
  280. File: WinArrange_E.doc,  Node: History,  Next: Concept Index,  Prev: Hints,  Up: Top
  281. History
  282. *******
  283.    Here is a list of the versions:
  284.    * Release 1 (Winarrange 0.67beta)
  285.      Initial Aminet release. Available on AminetCD6 `aminet/util/misc'.
  286.    * Release 2 (WinArrange 0.68beta)
  287.      Winarrange now accepts `Jokers' like: `ACCEPTWINDOW This?*Joker'.
  288.           Please consult the documentation for detailed information.
  289.      Note: The `ACCEPT/REJECTTASK' options do not work yet.
  290. File: WinArrange_E.doc,  Node: Concept Index,  Prev: History,  Up: Top
  291. Concept Index
  292. *************
  293.      * Menu:
  294.      
  295.      * Choosetype:                      Tutorial.
  296.      * Configuring:                     Configuring.
  297.      * fontsensitiv:                    Shell-Options.
  298.      * Hints:                           Hints.
  299.      * History:                         History.
  300.      * Installation:                    Installation.
  301.      * Purpose:                         Purpose.
  302.      * Shell-Options:                   Shell-Options.
  303.      * Sorttype:                        Tutorial.
  304.      * Structure of the config-file:    Configuring.
  305.      * Tutorial:                        Tutorial.
  306.      * Usage:                           Usage.
  307.      * Using Wildcards:                 Configuring.
  308.      * config-file:                     Configuring.
  309.      
  310. Tag Table:
  311. Node: Top
  312. Node: Purpose
  313. Node: Installation
  314. Node: Usage
  315. Node: Tutorial
  316. Node: Shell-Options
  317. Node: Configuring
  318. Node: Hints
  319. 12336
  320. Node: History
  321. 12994
  322. Node: Concept Index
  323. 13486
  324. End Tag Table
  325.